org.springframework.cache.caffeine

Class CaffeineCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.cache.caffeine.CaffeineCache

All Implemented Interfaces:

Cache

@UsesJava8
public class CaffeineCache
extends AbstractValueAdaptingCache

Spring Cache adapter implementation on top of a Caffeine com.github.benmanes.caffeine.cache.Cache instance.

Requires Caffeine 2.1 or higher.

Since:

4.3

Author:

Ben Manes, Juergen Hoeller, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	CaffeineCache.LoadFunction
private class	CaffeineCache.PutIfAbsentFunction

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

Cache.ValueRetrievalException, Cache.ValueWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	cache
private java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
CaffeineCache(java.lang.String name, <any> cache) Create a CaffeineCache instance with the specified name and the given internal com.github.benmanes.caffeine.cache.Cache to use.
CaffeineCache(java.lang.String name, <any> cache, boolean allowNullValues) Create a CaffeineCache instance with the specified name and the given internal com.github.benmanes.caffeine.cache.Cache to use.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all mappings from the cache.
void	evict(java.lang.Object key) Evict the mapping for this key from this cache if it is present.
Cache.ValueWrapper	get(java.lang.Object key) Return the value to which this cache maps the specified key.
<T> T	get(java.lang.Object key, java.util.concurrent.Callable<T> valueLoader) Return the value to which this cache maps the specified key, obtaining that value from valueLoader if necessary.
java.lang.String	getName() Return the cache name.
<any>	getNativeCache() Return the underlying native cache provider.
protected java.lang.Object	lookup(java.lang.Object key) Perform an actual lookup in the underlying store.
void	put(java.lang.Object key, java.lang.Object value) Associate the specified value with the specified key in this cache.
Cache.ValueWrapper	putIfAbsent(java.lang.Object key, java.lang.Object value) Atomically associate the specified value with the specified key in this cache if it is not set already.

Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache

fromStoreValue, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private final java.lang.String name

cache

private final <any> cache

Constructor Detail

CaffeineCache

public CaffeineCache(java.lang.String name,
                     <any> cache)

Create a CaffeineCache instance with the specified name and the given internal com.github.benmanes.caffeine.cache.Cache to use.

Parameters:

name - the name of the cache

cache - the backing Caffeine Cache instance

CaffeineCache

public CaffeineCache(java.lang.String name,
                     <any> cache,
                     boolean allowNullValues)

Create a CaffeineCache instance with the specified name and the given internal com.github.benmanes.caffeine.cache.Cache to use.

Parameters:

name - the name of the cache

cache - the backing Caffeine Cache instance

allowNullValues - whether to accept and convert null values for this cache

Method Detail

getName

public final java.lang.String getName()

Description copied from interface: Cache

Return the cache name.

getNativeCache

public final <any> getNativeCache()

Description copied from interface: Cache

Return the underlying native cache provider.

get

public Cache.ValueWrapper get(java.lang.Object key)

Description copied from interface: Cache

Return the value to which this cache maps the specified key.

Returns null if the cache contains no mapping for this key; otherwise, the cached value (which may be null itself) will be returned in a Cache.ValueWrapper.

Specified by:

get in interface Cache

Overrides:

get in class AbstractValueAdaptingCache

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which this cache maps the specified key, contained within a Cache.ValueWrapper which may also hold a cached null value. A straight null being returned means that the cache contains no mapping for this key.

See Also:

Cache.get(Object, Class)

get

public <T> T get(java.lang.Object key,
                 java.util.concurrent.Callable<T> valueLoader)

Description copied from interface: Cache

Return the value to which this cache maps the specified key, obtaining that value from valueLoader if necessary. This method provides a simple substitute for the conventional "if cached, return; otherwise create, cache and return" pattern.

If possible, implementations should ensure that the loading operation is synchronized so that the specified valueLoader is only called once in case of concurrent access on the same key.

If the valueLoader throws an exception, it is wrapped in a Cache.ValueRetrievalException

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which this cache maps the specified key

lookup

protected java.lang.Object lookup(java.lang.Object key)

Description copied from class: AbstractValueAdaptingCache

Perform an actual lookup in the underlying store.

Specified by:

lookup in class AbstractValueAdaptingCache

Parameters:

key - the key whose associated value is to be returned

Returns:

the raw store value for the key

put

public void put(java.lang.Object key,
                java.lang.Object value)

Description copied from interface: Cache

Associate the specified value with the specified key in this cache.

If the cache previously contained a mapping for this key, the old value is replaced by the specified value.

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

putIfAbsent

public Cache.ValueWrapper putIfAbsent(java.lang.Object key,
                                      java.lang.Object value)

Description copied from interface: Cache

Atomically associate the specified value with the specified key in this cache if it is not set already.

This is equivalent to:

 Object existingValue = cache.get(key);
 if (existingValue == null) {
     cache.put(key, value);
     return null;
 } else {
     return existingValue;
 }
 

except that the action is performed atomically. While all out-of-the-box CacheManager implementations are able to perform the put atomically, the operation may also be implemented in two steps, e.g. with a check for presence and a subsequent put, in a non-atomic way. Check the documentation of the native cache implementation that you are using for more details.

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

Returns:

the value to which this cache maps the specified key (which may be null itself), or also null if the cache did not contain any mapping for that key prior to this call. Returning null is therefore an indicator that the given value has been associated with the key.

evict

public void evict(java.lang.Object key)

Description copied from interface: Cache

Evict the mapping for this key from this cache if it is present.

Parameters:

key - the key whose mapping is to be removed from the cache

clear

public void clear()

Description copied from interface: Cache

Remove all mappings from the cache.